Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions That Modify Movie Properties / Working With Movie Spatial Characteristics

SetMovieDisplayClipRgn

The SetMovieDisplayClipRgn function allows your application to establish a movie's current display clipping region.

pascal void SetMovieDisplayClipRgn (Movie theMovie, 
                                    RgnHandle theClip);

theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle (described on page 2-80, page 2-76, and page 2-78, respectively).

theClip

Contains a handle to the movie's display clipping region. Note that the Movie Toolbox makes a copy of this region. Your application must dispose of the region referred to by this parameter when you are done with it. Set this parameter to nil to disable a movie's clipping region.

DESCRIPTION

The display clipping region defines any final clipping that is applied to the movie before it is displayed, and it is valid for the entire duration of the movie. You must use this region to clip a movie because the Movie Toolbox ignores the clip region of the movie's graphics world during display processing.

Note that the display clipping region is not saved with the movie.

SPECIAL CONSIDERATIONS

Do not use the SetMovieDisplayClipRgn function when you are using a movie controller component--use the movie controller component function MCSetClip instead. For details on the MCSetClip function, see the chapter "Movie Controller Components" in Inside Macintosh: QuickTime Components.

ERROR CODES

invalidMovie

-2010

This movie is corrupted or invalid

Memory Manager errors

SEE ALSO

You can retrieve the display clipping region by calling the GetMovieDisplayClipRgn function, which is described in the next section.